Skip to content

fix: Add exam_name and ready_to_resume to Inst Dash Special Exams tab#38505

Open
brianjbuck-wgu wants to merge 2 commits intoopenedx:masterfrom
WGU-Open-edX:bugfix/issue-38504-exam-name-ready-to-resume
Open

fix: Add exam_name and ready_to_resume to Inst Dash Special Exams tab#38505
brianjbuck-wgu wants to merge 2 commits intoopenedx:masterfrom
WGU-Open-edX:bugfix/issue-38504-exam-name-ready-to-resume

Conversation

@brianjbuck-wgu
Copy link
Copy Markdown
Contributor

@brianjbuck-wgu brianjbuck-wgu commented May 1, 2026 •
edited
Loading

Description

Adds the fields exam_name and ready_to_resume to:

  1. Per-exam attempts: GET /api/instructor/v2/courses/{course_id}/special_exams/{exam_id}/attempts
  2. Course-wide attempts: GET /api/instructor/v2/courses/{course_id}/special_exams/attempts

Closes: #38504

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 1, 2026
@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented May 1, 2026 •
edited
Loading

Thanks for the pull request, @brianjbuck-wgu!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions May 1, 2026
@brianjbuck-wgu brianjbuck-wgu marked this pull request as ready for review May 1, 2026 15:47
@brianjbuck-wgu brianjbuck-wgu requested a review from Copilot May 1, 2026 15:51
Copilot AI reviewed May 1, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds additional attempt metadata to the Instructor Dashboard “Special Exams” API responses to support UI needs (issue #38504), by exposing exam display name and whether an attempt can be resumed.

Changes:

  • Expose exam_name on ExamAttemptSerializer (from proctored_exam.exam_name).
  • Expose ready_to_resume on ExamAttemptSerializer and add basic response assertions in existing API tests.
  • Update the OpenAPI spec to document the new response fields.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
lms/djangoapps/instructor/views/serializers_v2.py Adds exam_name and ready_to_resume fields to the attempts serializer used by both attempts endpoints.
lms/djangoapps/instructor/tests/views/test_special_exams_api_v2.py Extends API tests to assert the new response fields are present.
lms/djangoapps/instructor/docs/references/instructor-v2-special-exams-api-spec.yaml Documents the new ExamAttempt response properties.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread lms/djangoapps/instructor/tests/views/test_special_exams_api_v2.py
Comment thread lms/djangoapps/instructor/tests/views/test_special_exams_api_v2.py
Comment thread lms/djangoapps/instructor/views/serializers_v2.py Outdated
@brianjbuck-wgu brianjbuck-wgu force-pushed the bugfix/issue-38504-exam-name-ready-to-resume branch from 054e7ae to 16ec12e Compare May 1, 2026 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Contributions
Status: Needs Triage

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Instructor Dashboard

3 participants

@brianjbuck-wgu @openedx-webhooks